Loading TOC...

GET /manage/v2/databases/{id|name}/partitions/{name}/properties

Summary

Retrieve the current configuration for the partition identified by {name} in the database identified by {name|id}.

URL Parameters
format The format of the returned data. Can be html, json or xml (default). If present, the format parameter overrides the Accept header.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header. Allowed values: application/xml, application/json, and text/html.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested information. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

availability

Availability of the forest data.

updates-allowed

The kinds of updates that should be allowed for this forest.

query-exclusion

Example


http://localhost:8002/manage/v2/databases/example-db/partitions/2012/properties

==>  Returns summary of the partition named 2012 in the database example-db.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.